Transforms forReportBean


ReportSavePropertiesTransform

Formal Parameter Type Default Required Description
addFileNameToURL BOOLEAN true false Determines whether to add the file name at the end of the URL.
This is added to aid the browser on choosing a file name when a PDF or Excel file is saved when displayed embeded in the browser.
The file name is added in the form:
...mstrWeb?n=/FileName.pdf
allowCloseWindow BOOLEAN false false Formal parameter that displays special HTML to allow users the possiblity to close the window where this transform will be rendered
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssErrorMessage STRING error-message false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorTitle STRING error-title false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssUseFileContent BOOLEAN false false This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
eventToForwardTo INTEGER 3001 false This is the name of the event to redirect to after updating the report page state.
Allowed Values: integer values representing WebEvent. It shall be defined in appBeanEvents.xml or mdBeanEvents.xml.
extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
globalCssErrorMessage STRING error-message false

Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


CSS to be used in all error messages.
globalCssErrorTitle STRING error-title false

Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


CSS to be used in all Error titles.
height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
initialIndent INTEGER 0 false

Deprecated. Indentation is not appended by Transforms anymore.


Indicates the initial indentation of the HTML generated.
reloadPageName STRING report false Defines the name of the Parent Page to reload after saving Properties on the options page (used for HTML mode) Default value is "report" Allowed values - String value. Should be a page name.
scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
setEventArguments BOOLEAN true false Defines if the arguments of the event to forward to should be set or not.
Default is true, to be set to false when only passing the bean state is required.
Allowed Values: TRUE/FALSE.
useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
If not set, the bean's OutputFormat() method will be used.
useURLRedirect BOOLEAN true false Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.
The fake URL has the following format:
  • for aspx:"Microstrategy/asp/number.exp.aspx"
  • for jsp: "Microstrategy/export/number"
    where the number is a unique identifier.
    Internally we will redirect to the appropiate ASP/servlet.